<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfXmppManager</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinfinity-0.4 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi">
<link rel="next" href="InfIo.html" title="InfIo">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="InfDiscoveryAvahi.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.4 Reference Manual</th>
<td><a accesskey="n" href="InfIo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfXmppManager.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InfXmppManager.description" class="shortcut">Description</a>
                   | 
                  <a href="#InfXmppManager.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#InfXmppManager.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="InfXmppManager">
<a name="InfXmppManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfXmppManager.top_of_page"></a>InfXmppManager</span></h2>
<p>InfXmppManager — Reuse existing connections</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="InfXmppManager.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="InfXmppManager.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libinfinity/common/inf-xmpp-manager.h&gt;

                    <a class="link" href="InfXmppManager.html#InfXmppManager-struct" title="InfXmppManager">InfXmppManager</a>;
                    <a class="link" href="InfXmppManager.html#InfXmppManagerClass" title="InfXmppManagerClass">InfXmppManagerClass</a>;
<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="returnvalue">InfXmppManager</span></a> *    <a class="link" href="InfXmppManager.html#inf-xmpp-manager-new" title="inf_xmpp_manager_new ()">inf_xmpp_manager_new</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="returnvalue">InfXmppConnection</span></a> * <a class="link" href="InfXmppManager.html#inf-xmpp-manager-lookup-connection-by-address" title="inf_xmpp_manager_lookup_connection_by_address ()">inf_xmpp_manager_lookup_connection_by_address</a>
                                                        (<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libinfinity-0.4-InfIpAddress.html#InfIpAddress" title="InfIpAddress"><span class="type">InfIpAddress</span></a> *address</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> port</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfXmppManager.html#inf-xmpp-manager-contains-connection" title="inf_xmpp_manager_contains_connection ()">inf_xmpp_manager_contains_connection</a>
                                                        (<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfXmppManager.html#inf-xmpp-manager-add-connection" title="inf_xmpp_manager_add_connection ()">inf_xmpp_manager_add_connection</a>     (<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfXmppManager.html#inf-xmpp-manager-remove-connection" title="inf_xmpp_manager_remove_connection ()">inf_xmpp_manager_remove_connection</a>  (<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="InfXmppManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----InfXmppManager
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="InfXmppManager.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="InfXmppManager.html#InfXmppManager-add-connection" title='The "add-connection" signal'>add-connection</a>"                                 : Run Last
  "<a class="link" href="InfXmppManager.html#InfXmppManager-remove-connection" title='The "remove-connection" signal'>remove-connection</a>"                              : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="InfXmppManager.description"></a><h2>Description</h2>
<p>
<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> stores <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> objects and allows to look them
up by the IP address and port number of their underlaying
<a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>s. This can be used to reuse existing network
connections instead of creating new ones.
</p>
<p>
Each object which needs to make connections should be passed a
<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>. Then, when making a connection to a certain address/port
pair, it should first look in the XMPP manager whether there is already
an existing connection to the destination host, via
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-lookup-connection-by-address" title="inf_xmpp_manager_lookup_connection_by_address ()"><code class="function">inf_xmpp_manager_lookup_connection_by_address()</code></a>. If there is, it should
use it (maybe reopen it if it is closed). Otherwise, it should create a
new connection and it to the XMPP manager via
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-add-connection" title="inf_xmpp_manager_add_connection ()"><code class="function">inf_xmpp_manager_add_connection()</code></a> for others to use.
</p>
</div>
<div class="refsect1" title="Details">
<a name="InfXmppManager.details"></a><h2>Details</h2>
<div class="refsect2" title="InfXmppManager">
<a name="InfXmppManager-struct"></a><h3>InfXmppManager</h3>
<pre class="programlisting">typedef struct _InfXmppManager InfXmppManager;</pre>
<p>
<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> is an opaque data type. You should only access it via the
public API functions.
</p>
</div>
<hr>
<div class="refsect2" title="InfXmppManagerClass">
<a name="InfXmppManagerClass"></a><h3>InfXmppManagerClass</h3>
<pre class="programlisting">typedef struct {
  void(*add_connection)(InfXmppManager* manager,
                        InfXmppConnection* connection);
  void(*remove_connection)(InfXmppManager* manager,
                           InfXmppConnection* connection);
} InfXmppManagerClass;
</pre>
<p>
This structure contains the default signal handlers for <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="InfXmppManagerClass.add-connection"></a>add_connection</code></em> ()</span></p></td>
<td>Default signal handler for the
<a class="link" href="InfXmppManager.html#InfXmppManager-add-connection" title='The "add-connection" signal'><span class="type">"add-connection"</span></a> signal. It adds the connection to the
manager's internal storage.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="InfXmppManagerClass.remove-connection"></a>remove_connection</code></em> ()</span></p></td>
<td>Default signal handler for the
<a class="link" href="InfXmppManager.html#InfXmppManager-remove-connection" title='The "remove-connection" signal'><span class="type">"remove-connection"</span></a> signal. It removes the connection from
the manager's internal storage.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_xmpp_manager_new ()">
<a name="inf-xmpp-manager-new"></a><h3>inf_xmpp_manager_new ()</h3>
<pre class="programlisting"><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="returnvalue">InfXmppManager</span></a> *    inf_xmpp_manager_new                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new xmpp manager.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_xmpp_manager_lookup_connection_by_address ()">
<a name="inf-xmpp-manager-lookup-connection-by-address"></a><h3>inf_xmpp_manager_lookup_connection_by_address ()</h3>
<pre class="programlisting"><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="returnvalue">InfXmppConnection</span></a> * inf_xmpp_manager_lookup_connection_by_address
                                                        (<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libinfinity-0.4-InfIpAddress.html#InfIpAddress" title="InfIpAddress"><span class="type">InfIpAddress</span></a> *address</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> port</code></em>);</pre>
<p>
Looks for a <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> contained in <em class="parameter"><code>manager</code></em> whose underlaying
<a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> has the given address and port set. Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if
there is no such connection.
</p>
<p>
This function may also return a closed connection. You can then attempt to
reopen it, or remove it from the manager using
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-remove-connection" title="inf_xmpp_manager_remove_connection ()"><code class="function">inf_xmpp_manager_remove_connection()</code></a> when that fails.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>A <span class="type">InfConnectionManager</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em> :</span></p></td>
<td>The remote <a class="link" href="libinfinity-0.4-InfIpAddress.html#InfIpAddress" title="InfIpAddress"><span class="type">InfIpAddress</span></a> of the connection to look for.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>port</code></em> :</span></p></td>
<td>The remote port number of the connection to look for.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> with the given address and port, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on
error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_xmpp_manager_contains_connection ()">
<a name="inf-xmpp-manager-contains-connection"></a><h3>inf_xmpp_manager_contains_connection ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            inf_xmpp_manager_contains_connection
                                                        (<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection</code></em>);</pre>
<p>
Returns whether <em class="parameter"><code>connection</code></em> is contained in <em class="parameter"><code>manager</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>A <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>connection</code></em> is contained in <em class="parameter"><code>manager</code></em>, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_xmpp_manager_add_connection ()">
<a name="inf-xmpp-manager-add-connection"></a><h3>inf_xmpp_manager_add_connection ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_xmpp_manager_add_connection     (<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection</code></em>);</pre>
<p>
Adds the given connection to <em class="parameter"><code>manager</code></em> so that it is found by
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-lookup-connection-by-address" title="inf_xmpp_manager_lookup_connection_by_address ()"><code class="function">inf_xmpp_manager_lookup_connection_by_address()</code></a> and
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-contains-connection" title="inf_xmpp_manager_contains_connection ()"><code class="function">inf_xmpp_manager_contains_connection()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>A <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> not yet contained in <em class="parameter"><code>manager</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_xmpp_manager_remove_connection ()">
<a name="inf-xmpp-manager-remove-connection"></a><h3>inf_xmpp_manager_remove_connection ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_xmpp_manager_remove_connection  (<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection</code></em>);</pre>
<p>
Removes the given connection from <em class="parameter"><code>manager</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>A <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> contained in <em class="parameter"><code>manager</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="InfXmppManager.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "add-connection" signal'>
<a name="InfXmppManager-add-connection"></a><h3>The <code class="literal">"add-connection"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>    *xmpp_manager,
                                                        <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)         : Run Last</pre>
<p>
This signal is emitted whenever a new connection has been added to the
<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>, via <a class="link" href="InfXmppManager.html#inf-xmpp-manager-add-connection" title="inf_xmpp_manager_add_connection ()"><code class="function">inf_xmpp_manager_add_connection()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>xmpp_manager</code></em> :</span></p></td>
<td>The <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>The <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> that was added to <em class="parameter"><code>xmpp_manager</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title='The "remove-connection" signal'>
<a name="InfXmppManager-remove-connection"></a><h3>The <code class="literal">"remove-connection"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>    *xmpp_manager,
                                                        <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)         : Run Last</pre>
<p>
This signal is emitted whenever a connection has been removed from the
<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>, via <a class="link" href="InfXmppManager.html#inf-xmpp-manager-remove-connection" title="inf_xmpp_manager_remove_connection ()"><code class="function">inf_xmpp_manager_remove_connection()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>xmpp_manager</code></em> :</span></p></td>
<td>The <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> emitting the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>The <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> that was removed from <em class="parameter"><code>xmpp_manager</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>